package club.babyf.lbs.entity.amap.req;

import lombok.Data;

/**
 * GeoCodeGeoParameterDto.
 *
 * @author zhanglei.
 * @date 2025/1/10 15:26.
 * @description 地理编码 请求参数.
 */
@Data
public class GeoCodeGeoParameterDto {

    /**
     * 高德Key
     * 用户在高德地图官网 申请 Web 服务 API 类型 Key：<a href="https://console.amap.com/dev/index">...</a>
     * 必填
     */
    private String key;

    /**
     * 结构化地址信息
     * 规则遵循：国家、省份、城市、区县、城镇、乡村、街道、门牌号码、屋邨、大厦，如：北京市朝阳区阜通东大街6号。
     * 必填
     */
    private String address;

    /**
     * 指定查询的城市
     * 可选输入内容包括：指定城市的中文（如北京）、指定城市的中文全拼（beijing）、citycode（010）、adcode（110000），不支持县级市。当指定城市查询内容为空时，会进行全国范围内的地址转换检索。
     * adcode 信息可参考 城市编码表：<a href="https://lbs.amap.com/api/webservice/download">...</a> 获取
     * 非必填
     */
    private String city;

    /**
     * 数字签名
     * 请参考 数字签名获取和使用方法：<a href="https://lbs.amap.com/faq/quota-key/key/41169">...</a>
     * 非必填
     */
    private String sig;

    /**
     * 返回数据格式类型
     * 可选输入内容包括：JSON，XML。设置 JSON 返回结果数据将会以 JSON 结构构成；如果设置 XML 返回结果数据将以 XML 结构构成。
     * 非必填
     * 默认值：JSON
     */
    private String output;

    /**
     * 回调函数
     * callback 值是用户定义的函数名称，此参数只在 output 参数设置为 JSON 时有效。
     * 非必填
     */
    private String callback;

}
